/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.druid.indexer;

import org.apache.druid.java.util.common.UOE;

import javax.annotation.Nullable;
import java.util.Map;

/**
 */
public interface Jobby
{
  boolean run();

  /**
   * @return A map containing statistics for a Jobby, optionally null if the Jobby is unable to provide stats.
   */
  @Nullable
  default Map<String, Object> getStats()
  {
    throw new UOE("This Jobby does not implement getJobStats(), Jobby class: [%s]", getClass());
  }

  /**
   * @return A string representing the error that caused a Jobby to fail. Can be null if the Jobby did not fail,
   * or is unable to provide an error message.
   */
  @Nullable
  default String getErrorMessage()
  {
    throw new UOE("This Jobby does not implement getErrorMessage(), Jobby class: [%s]", getClass());
  }
}
